aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMountain Man <43313373+MountainMan1312@users.noreply.github.com>2023-06-05 21:58:58 -0400
committerMountain Man <43313373+MountainMan1312@users.noreply.github.com>2023-06-05 21:58:58 -0400
commitc07558da3caaf436742d541be638b78396ea88d5 (patch)
treeb7ca948c418fc63d6f84270d1abe1ba234cd280d
parentFix `mc/cmds-to-run-for-all` (diff)
downloadmmosmacs-c07558da3caaf436742d541be638b78396ea88d5.tar.gz
mmosmacs-c07558da3caaf436742d541be638b78396ea88d5.tar.bz2
mmosmacs-c07558da3caaf436742d541be638b78396ea88d5.zip
Rewrite `CONTRIBUTING.md`
-rw-r--r--CONTRIBUTING.md73
1 files changed, 21 insertions, 52 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index c331bf9..e7a3942 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,69 +1,55 @@
1# Contributing to MMOSMacs 1# Contributing to MMOSMacs
2 2
3Howdy, and welcome to the MMOSMacs git repository. This document 3Howdy, and welcome to the MMOSMacs git repository. This document outlines the conventions and standards for contributing to the project.
4outlines the conventions and standards for the project.
5 4
6 5
7## This is personal 6## This is personal
8 7
9Please understand that this is my personal Emacs configuration. MMOSMacs 8Please understand that this is my personal Emacs configuration. MMOSMacs is designed to meet my personal needs. I welcome any and all contributions, and I will do my best to make MMOSMacs accessible to others, but my needs and preferences ultimately take priority.
10is designed to meet my personal needs. I welcome any and all
11contributions, and I will do my best to make MMOSMacs accessible to
12others, but my needs and preferences ultimately take priority.
13 9
14All contributors are listed at the end of this document. If you have 10All contributors are listed at the end of this document. If you have contributed and your name does not appear here, submit a PR or RFC Issue for it to be added.
15contributed and your name does not appear here, submit a PR or RFC Issue
16for it to be added.
17 11
18 12
19## Code of Conduct 13## Code of Conduct
20 14
21I will reject all contributions from: 15I will reject all contributions from:
22- people who abuse other contributors. 16- people who abuse me or other contributors.
23- people I know to be affiliated with any state agency. 17- people I know to be affiliated with any state agency.
24 18
25Furthermore, individual items will be rejected because of: 19Furthermore, individual items will be rejected because of:
26- exceptionally vulgar language. 20- exceptionally vulgar language.
27- ignorance or disregard of the `STYLE_GUIDE.md` or Issue templates. 21- ignorance or disregard of `STYLE_GUIDE.md`.
28 22
29 23
30## How to Contribute 24## How to Contribute
31 25
32There are several ways you can contribute. 26There are several ways you can contribute.
33 27
34The easiest way you can contribute is by taking part in the discussions 28The easiest way you can contribute is by taking part in the discussions on the [GitHub Issues page](https://github.com/MountainMan1312/MMOSMacs/issues). You can comment on topics that already have an existing Issue, or you can submit your own if it does not already exist. Issues can take the form of:
35on the [GitHub Issues page](https://github.com/MountainMan1312/MMOSMacs/issues). 29
36You can comment on topics that already have an existing Issue, or you
37can submit your own if it does not already exist. Issues can take the
38form of:
39- **RFC**: discussion about making a change to MMOSMacs. 30- **RFC**: discussion about making a change to MMOSMacs.
40- **Bug Report**: discusion about a problem with the MMOSMacs code. 31- **Bug Report**: discusion about a problem with the MMOSMacs code.
41- **Feedback**: share your thoughts about MMOSMacs. 32- **Feedback**: share your thoughts about MMOSMacs.
42 33
43Before submitting a new issue, search for existing duplicate issues. If 34Before submitting a new issue, search for existing duplicate issues. If it already exists, comment on the existing Issue instead of making a new one. Duplicate issues will be removed and you will be asked to move your post to the comment section of the existing post. It's not to be rude, it's just for organization's sake.
44it already exists, comment on the existing Issue instead of making a new
45one. Duplicate issues will be removed and you will be asked to move your
46post to the comment section of the existing post. It's not to be rude,
47it's just for organization's sake.
48 35
49To contribute code: 36To contribute code:
37
501. Make an RFC or find an existing one 381. Make an RFC or find an existing one
512. Discuss your proposed changes 392. Discuss your proposed changes
523. Create a branch 403. Create a branch
534. Make your changes 414. Make your changes
545. Submit a Pull Request 425. Submit a Pull Request
436. Wait for feedback
55 44
56 45
57### RFC Issues, branches, commits, & Pull Requests 46### RFC Issues, branches, commits, & Pull Requests
58 47
59#### Writing an RFC 48#### Writing an RFC
60 49
61RFCs are the main form of project management for this repository. All 50RFCs are the main way contributors can request or suggest changes. I do not use RFCs as project management, so there may be plans that haven't been discussed anywhere.
62major changes to MMOSMacs should have an associated RFC. RFC Issues 51
63should be named in the format `RFC: TITLE`, where title is a short 52RFC Issues should be named in the format `RFC: TITLE`, where title is a short description of the proposed changes. For example, the RFC to modify a few default Emacs things as a starting point for MMOSMacs is called `RFC: Start with sensible defaults`.
64description of the proposed changes. For example, the RFC to modify a
65few default Emacs things as a starting point for MMOSMacs is called
66`RFC: Start with sensible defaults`.
67 53
68The following template should be used when writing an RFC. 54The following template should be used when writing an RFC.
69 55
@@ -75,21 +61,17 @@ Provide a one-paragraph summary of the proposed changes
75 61
76# Rationale and motivation 62# Rationale and motivation
77 63
78Explain why this change is necessary or desirable. Relate to any other 64Explain why this change is necessary or desirable. Relate to any other relevant RFCs, Bug Reports, or Feedback. Feel free to link to Issues from other repositories as well.
79relevant RFCs, Bug Reports, or Feedback. Feel free to link to Issues
80from other repositories as well.
81 65
82 66
83# Details 67# Details
84 68
85Provide an in-depth description of your proposed changes. This should 69Provide an in-depth description of your proposed changes. This should get into specifics and corner-cases.
86get into specifics and corner-cases.
87 70
88 71
89# Drawbacks and Alternatives (optional) 72# Drawbacks and Alternatives (optional)
90 73
91Why should these changes NOT be implemented? What other options are 74Why should these changes NOT be implemented? What other options are there, and why are these changes better than the alternatives?
92there, and why are these changes better than the alternatives?
93 75
94 76
95# Additional resources (optional) 77# Additional resources (optional)
@@ -105,27 +87,14 @@ Ask any further questions you have.
105 87
106#### Creating branches & committing changes 88#### Creating branches & committing changes
107 89
108All changes made as part of an RFC should be made in an associated 90All changes made as part of an RFC should be made in an associated branch. The branch should be named in the format `TYPE/#/TITLE`, where TYPE is one of `RFC, BUG`, X is the Issue number, and TITLE is a short summary of the RFC title. For example the branch for
109branch. The branch should be named in the format `TYPE/#/TITLE`, where 91`RFC: Start with sensible defaults` is named `RFC/2/sensible-defaults`. Branch names should be short, with an absolute maximum of 72 characters (preferrably shorter).
110TYPE is one of `RFC, BUG`, X is the Issue number, and TITLE is a short
111summary of the RFC title. For example the branch for
112`RFC: Start with sensible defaults` is named `RFC/2/sensible-defaults`.
113Branch names should be short, with an absolute maximum of 72 characters
114(preferrably shorter).
115 92
116Commits should be small and nuclear. They should each do "one thing". 93Commits should be small and nuclear. They should each do "one thing". That said, multiple files could theoretically be affected by a single commit. Commit messages should be brief, but not omit any necessary detail.
117That said, multiple files could theoretically be affected by a single
118commit. Commit messages should be brief, but not omit any necessary
119detail.
120 94
121 95
122#### Writing a Pull Request 96#### Writing a Pull Request
123 97
124Like RFCs, all major changes to MMOSMacs must have an associated Pull 98Like RFCs, all major changes to MMOSMacs must have an associated Pull Reqest, which explains in detail the changes that were made. Pull Requests are reviewed before the changes are accepted into the stable branch, and it is likely that the reviewer will reject your changes with notes on what needs to be fixed.
125Reqest, which explains in detail the changes that were made. Pull
126Requests are reviewed before the changes are accepted into the stable
127branch, and it is likely that the reviewer will reject your changes with
128notes on what needs to be fixed.
129 99
130Pull Requests should explain the specifics and nuances of the changes 100Pull Requests should explain the specifics and nuances of the changes contained therein.
131contained therein.